Shareware Grab Bag/Shareware Grab Bag.iso/095/pu10.arc/PU10.DOC

Text File | 1987-04-18 | 15KB | 295 lines

       PU Version 1.0                                              Page - 1

       PU - A Harvard BBS Utility


       PU is a utility designed for PC-Board 11.X systems.  PU stands for
       'process users'.  Its purpose is to help maintain security levels
       within your users base and create reports of your users activities.

       Features:

          o Changes security level based on upload/download ratios
          o Changes security level based on top uploads
          o Creates list of top uploaders
          o Creates list of all users with various stats
          o No sec. level change for certain users (i.e. Subscribers etc..)
          o Very fast running (900 users in under 20 seconds on AT)
          o Designed for EVENT.SYS unattended operation
          o Creates backup file before any modification of user file
          o Share compatible (only for userlist and topuploader list)


       A major reason for the writing of this utility was to combine many
       of the security related programs into one comprehensive program that
       does everything better and faster.

       PU is designed to let you use any one or all of its features.  You
       can create a userlist or a top uploaders list or even both without
       having to change any security levels.  You can also change security
       levels based on DL/UL ratios without the need to create any
       userlists or reports.  PU uses the command line and a configuration
       file for its operation.  A sample CFG file is included in the
       distribution.  The PU.CFG file should be modified to reflect the
       file locations and security levels of your board.  The file should
       be altered with care since the program reads it in a certain order.
       All of the configuration lines must be present, this is excluding
       comment lines which we will later discuss.

       The Format of configuration-file is:

          1) Name of PC-Board users file
          2) File where Userlist goes
          3) Sec. Level not to change if <= or >= to
          4) Sec. Levels not to change no matter what
          5) # or top ul's, New Sec. Level, Report file, Report footer
          6) Upload/Download ratios, Security levels

       There are five one line data lines (Items #1 through #5).  Each of
       these lines has all information contained on one line.  Item #6, the
       DL/UL ratio calculator, can have a multiple number of lines.  All of
       these six items must be present since the program looks for the data
       by line in this specific order.

       PU Version 1.0                                              Page - 2


       Every line in the configuration file with a ';' before it is
       ignored, these lines are all considered comments.  A ';' after
       information on a data line may also be used to represent a comment.
       The data lines may be separated by as many comment lines as you wish
       or comment lines may be left out entirely.

       We will now examine each of the different items in the order which
       they appear in the configuration file.

       (Item #1) - The location of the users file.

       This line simply tells the program where to find the users file.  It
       must contain a valid PC-Board 11 users file or the program will not
       be able to do anything.  An example line taken from a sample
       configuration file is as follows:

       c:\pcb\main\users ; This is the PC-Board Users file.

       Notice that a comment may be placed after the data by inserting a
       ';', just as comments are inserted between the data lines.

       (Item #2) - Name of userlist report.

       This line tells PU where to place the userlist that it will create
       if the userlist option is selected.   Many sysops will want to send
       the userlist output straight to a bulletin.  An example line is as
       follows:

       c:\pcb\gen\blt7   ; This will be where the Userlist is output

       (Item #3) -  Sec. Level not to change if <= or >= to

       This line contains 2 numbers representing a minimum and a maximum
       security level that should not be modified.  PU will not change any
       level equal or less than the first number nor will it change any
       level equal to or greater than second number.  This option is useful
       if you have a certain level that everyone above or below is exempt
       from the DL/UL security and top uploaders security level
       calculations.  For example I keep all my subscribers and special
       users at a level of 80 or higher.  I do not have a lower level I
       don't wish to change so my line is as follows:

       0 80 ; Do not alter S. Level <= 0, or >= 80

       Note that PU will never alter a security level >= to 100.  It will
       also never change a security level equal to  0, since a 0 represent
       deleted and/or locked out users.  These values are hardcoded into
       the program and may not be changed.  This insures that the sysop's
       record and locked out users will not have their security levels
       changed.


       PU Version 1.0                                              Page - 3

       (Item #4) - Misc. levels not to change no matter what.

       This line is for misc. security levels not to alter.  This line is
       used for any security levels that you wish not to alter that do not
       fall into item #3 scope.  You may have as many numbers as you want
       in this line, but must have at least 1 number, even if it is zero.
       An example line is as follows:

       18 34 39 23 ; Security levels not to change no matter what

       (Item #5) - Topuploaders Information.

       This line contains information about what you want done with your
       topuploaders.  It is in the format of # of topuploaders you wish,
       security level to update users to, file you want topuploaders report
       sent to, and the footer text for the topuploaders report.  The first
       item is a number between 1 and 100, the second is a number between 0
       and 110, the third is a valid filename with optional path, etc.  If
       you don't want to change the security level of your topuploaders
       simply enter a 0 in the security level to update space.  If you do
       not want to use a footer in your top uploaders report simply enter
       'NUL' in that space.  You may still create a report and not update
       any security levels if you wish. An example line is as follows:

       10 61 C:\pcb\gen\blt3 c:\pcb\gen\footer ; #ul,N Level,Rpt,Footer

       (Item #6) - DL/UL ratio security.

       All the rest of the lines in the configuration file are devoted to
       figuring a users security level based on download to upload ratio.
       The lines must be in numerical order with the lowest numbers first.
       The download upload ratio is represented by using a negative number
       to represent more downloads then uploads and a positive number to
       represent more uploads then downloads, with zero being used to
       represent an equal amount. Thus if a person has downloaded 20 files
       and uploaded 5 his ratio would be -4 ( 20/5 with a negative sign
       used to represent more downloads then uploads.  If a user had
       downloaded 2 files and uploaded 5 his ratio would be 2.5 ( 5/2 with
       a positive sign used since there were more uploads then downloads).

       PU Version 1.0                                              Page - 4

       It is important to remember the larger of the two numbers is always
       the numerator of the fraction and the lower number is the
       denominator.  A special case occurs when someone has download a
       file(s) and uploaded zero or uploaded a file(s) and downloaded no
       files.  When this happens PU simply calculates the ratio by
       substituting a one for the zero.  For example ten downloads and zero
       uploads yields -10 ( 10/1 with neg. sign).  This is all probably
       easier to understand then it is to explain, so if you still don't
       understand look at the following example:

       -45 10 ; 45 Downloads to 1 or less uploads -- Security Level of 10
       -40 15 ; 40 Downloads to 1 or less uploads -- Security Level of 15
       -35 17 ; Any comments you wish can go after the ';'
       -25 25
       -20 30
       -15 35
       -14 40
       -10 45
       1.2 50
       1.5 55
       1.8 56
       2.0 57 ; Two uploads to every 1 download -- Sec. Level of 57
       2.5 58 ; 2.5 UL to 1 or less DL -- Security Level of 58
       3.0 59 ; 1 DL or less to 3 or more UL -- Security Level of 59


       Security levels are set starting from the lowest ratio (lowest
       number).  The program starts out by giving every user the lowest
       ratio available and working its way up to the ratio the user
       actually has.  So for example if a user had a ratio of -6 he would
       be awarded a security level of 45, since his level of -6 is > -10
       but < then the next ratio of 1.2.  A user with a ratio of 1.4 would
       be awarded a security level of 50 by the same reasoning.  A user
       with a ratio of -60 would be awarded a level security level of 10
       since that is the lowest ratio available in this configuration file.
       A user with a ratio of 6.5 would be awarded a security level of 59
       since that is the highest level in the configuration file.  I hope
       those were enough examples to make it clear how the system works.

       That is all there is to setting up the configuration file.  The
       easiest way to set it up is to make a copy of the PU.CFG that is
       included with the distribution and modify it to reflect the
       configuration of your system.

       Now we will talk about how to use PU.  PU operates by using the
       configuration file and command line switches.  If you simply enter
       PU without any switches a short help message will be printed.


       PU Version 1.0                                              Page - 5

       Usage for PU is:

       PU [configfile] [/U /T /S]

          /U -- Userlist - create a userlist
          /T -- Create a top uploaders bulletin
          /S -- Update people's security based on their DL/UL ratio

       The /U option will create a userlist report to whatever file you
       specified in the configuration file.  The action only reads the
       users file and does not write to it, thus no backup file is created.
       The /T option creates a topuploaders report.  It also only reads the
       users file, unless the /S option is also specified.  The /S option
       performs a security level update of the users file based on the
       DL/UL ratio lines in the cfg file.  Whenever the /S option is
       specified a backup users file is always created.  If the /S /T
       option are both specified the topuploaders will also have their
       security level updated to what is specified by the cfg file.  These
       options may be used in any order but they must all be separated by
       spaces and have a '/' in front of them.  A example is as follows:

       PU c:\pcbbin\pu\pu.cfg /T /U /S

       If you do not specify a configfile PU will try to use the file
       called PU.CFG in the current directory.  This above example would
       look for the cfg file in the specified location.  Then create a
       topuploaders and userlist report and also update security levels
       based on topuploaders and DL/UL ratios.

       This program should first be run on a backup of your users file.
       After running it check to make sure it has done what you want before
       using it on your working users file.  A good way to check is to
       browse through the updated users file with PCBEDIT.

       This program is distributed as is, and the authors make no warranty
       real or implied about its performance.  It has been tested, but the
       user must assume all risks when using the program.  Have a nice day.

       PU was written in C and compiled with Microsoft C 4.0.  We highly
       recommend this language for writing utilities such as these due to
       C's great speed and flexibility.  The MSC source may be released in
       the future but is not presently available due to ongoing
       modifications.


       PU Version 1.0                                              Page - 6

       The latest version of this program and many other BBS utilities may
       always be obtained from the sysop conference of the Harvard BBS.
       The BBS may be reached at the following numbers.

       Node #1 (public)         300/1200/2400       [phone]
       Node #2 (subscribers)    1200/2400           [phone]

       The sysop conference of the Harvard BBS is also home of PCBHOT, the
       other Harvard BBS utility.  Other BBS utilities are planned for the
       future. Please participate in the sysop conference and give us your
       ideas!

       Note:  The BBS will only be at the above numbers till the end of May
       1987.  New numbers will be posted on the BBS sometime in May.

       All written correspondence should be sent to:

          John W. Moon
          Mather 420
          Harvard University
          Cambridge, MA 02138

       PU is for the non-commercial use of all PC-Board sysops.  It is
       copyright by the Harvard BBS.  It is distributed as Sysopware.
       Sysopware is distributed under the concept of sysops helping other
       sysops.  No fee is requested for its use.  Most Sysops have enough
       financial burdens running a non-profitable BBS that they should not
       have to be burdened with paying for BBS utilities.

       The program was conceived by John Moon, sysop of the Harvard BBS.
       The majority of the actual programming was done by Paul King, a
       computer science major at Harvard University.  Both John and Paul
       may be contacted at the numbers or address listed above.  Thanks
       also go to Brian Miller (sysop, Channel One)  and Bud Napier (sysop,
       Future Technology) for their beta testing of PU.


       History:

       PU 1.0: April 18, 1987

          o Initial Release